Skip to content

Add indicator to avatar#10065

Merged
iwiznia merged 13 commits into
mainfrom
ionatan_brickroad_policy
Aug 1, 2022
Merged

Add indicator to avatar#10065
iwiznia merged 13 commits into
mainfrom
ionatan_brickroad_policy

Conversation

@iwiznia

@iwiznia iwiznia commented Jul 22, 2022

Copy link
Copy Markdown
Contributor

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/218719

Tests

This needs manually changing data/code to test (since the API is not done yet):

  • Expose Onyx variable to window ie: window.Onyx = Onyx on a file that imports Onyx
  • Set some errors in the employee list of a policy you have, ie: Onyx.set('policyMemberList_2D0BDD1B7A684C67', {"ionatan@expensify.com": {pending: 'add', errors: {1: 'This is an error'}}})
  • Check avatar has a red dot

image

- Check the policy you set the error in has a red dot

image

- Check manage members of that policy (but not others) has the red dot

image

- [Here](https://github.com/Expensify/App/blob/983d1922b2fd3e8a9e4359df7bba220a2d9e6753/src/pages/workspace/WorkspaceMembersPage.js#L272) add an error and pendingAction: ie: `.map(person => ({...person, pendingAction: 'delete', errors: {1: 'caca'}}))` - Check the member has the error displayed

image

- Note that dismissing the error is not working now, since the error is hardcoded in the code above

PR Review Checklist

Contributor (PR Author) Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • Any functional components have the displayName property
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The Contributor+ will copy/paste it into a new comment and complete it after the author checklist is completed

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • Any functional components have the displayName property
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

QA Steps

  • Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

iOS

Android

@iwiznia iwiznia self-assigned this Jul 22, 2022
@iwiznia iwiznia force-pushed the ionatan_brickroad_policy branch from dc9ac98 to 29ac710 Compare July 22, 2022 23:02
@iwiznia iwiznia force-pushed the ionatan_brickroad_policy branch from f8051a3 to 78fa853 Compare July 27, 2022 23:15
@iwiznia iwiznia marked this pull request as ready for review July 28, 2022 22:53
@iwiznia iwiznia requested a review from a team as a code owner July 28, 2022 22:53
@melvin-bot melvin-bot Bot requested review from aldo-expensify and removed request for a team July 28, 2022 22:53
@aldo-expensify

Copy link
Copy Markdown
Contributor

@iwiznia can you add some testing steps? please

@iwiznia

iwiznia commented Jul 29, 2022

Copy link
Copy Markdown
Contributor Author

Yeah sorry, sent this in late yesterday and wanted an early review (expecting comments and changes anyway). Doing that now. This is again a hard to test PR since the backend is not ready and so manual things are needed.

@aldo-expensify aldo-expensify left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gave it a first look to the code, left a small comment. It is looking good to me.

Would be good to get more eyes thought specially on the stuff about clearing the Onyx error.

I haven't tested it yet

Comment thread src/components/AvatarWithIndicator.js Outdated
styles.justifyContentCenter,
props.size === 'large' ? styles.statusIndicatorLarge : styles.statusIndicator,
];
const isLarge = props.size === 'large';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

move const isLarge = props.size === 'large'; before const indicatorStyles and use it in props.size === 'large' ? styles.statusIndicatorLarge : styles.statusIndicator,

@iwiznia iwiznia requested a review from thienlnam July 29, 2022 19:30

@thienlnam thienlnam left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did an initial review, looks good so far - a few questions, will item.login change?

Comment on lines -109 to -116
{this.props.isSyncing && (
<Icon
src={Expensicons.Sync}
fill={themeColors.textReversed}
width={6}
height={6}
/>
)}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we purposely removing the sync icon?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

Comment thread src/components/AvatarWithIndicator.js Outdated
isLarge ? styles.statusIndicatorLarge : styles.statusIndicator,
];

const hasError = _.some(props.policiesMemberList, policyMembers => hasPolicyMemberError(policyMembers));

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB: hasPolicyMemberError

Comment thread src/pages/policyMemberPropType.js Outdated
Comment on lines +12 to +14

/** Is this action pending? */
pending: PropTypes.string,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we also need pendingAction?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh crap, yes, this is wrong.

@iwiznia

iwiznia commented Aug 1, 2022

Copy link
Copy Markdown
Contributor Author

did an initial review, looks good so far - a few questions, will item.login change?

Probably...

Comment thread src/styles/styles.js
@iwiznia

iwiznia commented Aug 1, 2022

Copy link
Copy Markdown
Contributor Author

Seems @aldo-expensify is OOO, so merging as is. If there are additional comments, I can address those in another PR

@iwiznia iwiznia merged commit b71fd5d into main Aug 1, 2022
@iwiznia iwiznia deleted the ionatan_brickroad_policy branch August 1, 2022 19:44
@OSBotify

OSBotify commented Aug 1, 2022

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify

OSBotify commented Aug 1, 2022

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by @iwiznia in version: 1.1.87-0 🚀

platform result
🤖 android 🤖 failure ❌
🖥 desktop 🖥 failure ❌
🍎 iOS 🍎 failure ❌
🕸 web 🕸 failure ❌

@OSBotify

OSBotify commented Aug 4, 2022

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by @yuwenmemon in version: 1.1.87-9 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants